<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit - Firmware API: Serial - OSC</title>
<link href="mt_doxygen.css" rel="stylesheet" type="text/css" />
<link href="../resources/mt_doxytabs.css" rel="stylesheet" type="text/css" />
<style type="text/css">
<!--
.header {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 12pt;
	color: #222222;
}
-->
</style>
</head>

<body>
<table width="800" border="0">
    <tr>
      <td colspan="3">
        <form method="get" action="http://www.google.com/search">
          <div align="right">
            <input type="text"   name="q" size="25"
              maxlength="255" value="" />
            <input type="submit" value="Search" />
            <input type="hidden" name="sitesearch" value="makingthings.com/ref/firmware/html" />
          </div>
        </form>
       </td>
    </tr>
    <tr>
      <td><div align="center"><a href="http://www.makingthings.com">
				<img src="../resources/logo_brown_medium.png" alt="MakingThings"
									width="200" height="78" border="0" align="middle" longdesc="http://www.makingthings.com" /></a></div></td>
				<td><div align="center" class="header">
      		Make Controller Kit <br />
          Firmware API
      </div></td>
      <td><div align="center"><a href="http://www.makezine.com">
					<img src="../resources/make_logo.png" alt="MAKE Zine" 
										width="164" height="73" border="0" align="middle" longdesc="http://www.makezine.com" /></a></div></td>
    </tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.5.4 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
  var num=this.id.replace(/[^[0-9]/g,'');
  var button=this.firstChild;
  var sectionDiv=document.getElementById('dynsection'+num);
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
    sectionDiv.style.display='block';
    button.src='open.gif';
  }else{
    sectionDiv.style.display='none';
    button.src='closed.gif';
  }
}
function initDynSections(){
  var divs=document.getElementsByTagName('div');
  var sectionCounter=1;
  for(var i=0;i<divs.length-1;i++){
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
      var header=divs[i];
      var section=divs[i+1];
      var button=header.firstChild;
      if (button!='IMG'){
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
        button=document.createElement('img');
        divs[i].insertBefore(button,divs[i].firstChild);
      }
      header.style.cursor='pointer';
      header.onclick=changeDisplayState;
      header.id='dynheader'+sectionCounter;
      button.src='closed.gif';
      section.id='dynsection'+sectionCounter;
      section.style.display='none';
      section.style.marginLeft='14px';
      sectionCounter++;
    }
  }
}
window.onload = initDynSections;
-->
</script>
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>Serial - OSC<br>
<small>
[<a class="el" href="group___o_s_c.html">OSC</a>]</small>
</h1>Configure the Serial Port and Read Characters via OSC.  
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
</table>
<h2><a class="anchor" name="properties">
Properties</a></h2>
The Serial Subsystem has eight properties:<ul>
<li>baud</li><li>bits</li><li>stopbits</li><li>parity</li><li>hardwarehandshake</li><li>readable</li><li>char</li><li>block</li></ul>
<p>
<dl class="user" compact><dt><b>Baud</b></dt><dd>The Baud rate of the device. Valid from 110 baud to &gt;2M baud<br>
 To set baud rate to 115200, for example, send the message <div class="fragment"><pre class="fragment">/serial/baud 112500</pre></div></dd></dl>
<dl class="user" compact><dt><b>Bits</b></dt><dd>The number of bits per character. Can range from 5 to 8<br>
 To set the number of bits to 7, for example, send the message <div class="fragment"><pre class="fragment">/serial/bits 7</pre></div></dd></dl>
<dl class="user" compact><dt><b>StopBits</b></dt><dd>The number of stop bits per character. Can be 1 or 2<br>
 To set the number of stop bits to 2, for example, send the message <div class="fragment"><pre class="fragment">/serial/stopbits 2</pre></div></dd></dl>
<dl class="user" compact><dt><b>Parity</b></dt><dd>The parity of the character. Can be -1 for odd, 0 for none or 1 for even<br>
 To set the parity to even, for example, send the message <div class="fragment"><pre class="fragment">/serial/parity 1</pre></div></dd></dl>
<dl class="user" compact><dt><b>HardwareHandshake</b></dt><dd>Whether hardware handshaking (i.e. CTS RTS) is being employed.<br>
 To set hardware handshaking on, for example, send the message <div class="fragment"><pre class="fragment">/serial/hardwarehandshake 1</pre></div></dd></dl>
<dl class="user" compact><dt><b>Readable</b></dt><dd>How many characters are presently available to read.<br>
 To check, for example, send the message <div class="fragment"><pre class="fragment">/serial/readable</pre></div></dd></dl>
<dl class="user" compact><dt><b>Char</b></dt><dd>This property is the mechanism by which individual characters can be sent and received<br>
 To send a character 32 (a space), for example, send the message <div class="fragment"><pre class="fragment">/serial/char 32</pre></div> To get a character send the message <div class="fragment"><pre class="fragment">/serial/char</pre></div> In this case the reply will be an unsigned value between 0 and 255 or -1 if there is no character available.</dd></dl>
<dl class="user" compact><dt><b>Block</b></dt><dd>This property allows for reading or writing a block of characters to/from the serial port. If you're writing a block, you must send the block you want to write as an OSC blob.</dd></dl>
For example, to send a block: <div class="fragment"><pre class="fragment">/serial/block blockofchars</pre></div> To get a block, send the message <div class="fragment"><pre class="fragment">/serial/block</pre></div> In this case the reply will be a block of up to 100 unsigned chars, or the chars currently available to read from the serial port. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit</title>
<style type="text/css">
<!--
.footer {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 9pt;
	color: #999999;
}
-->
</style>
</head>

<body>
<hr size="1">
<div>
  <p class="footer">The Make Controller Kit is an open source project maintained by <a href="http://www.makingthings.com">MakingThings</a>.<br />
    MakingThings code is released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">Apache 2.0 license</a>.<br />
    Bug tracker, development wiki and status can be found at <a href="http://dev.makingthings.com">http://dev.makingthings.com</a>.<br />
		This document was last updated on 5 Dec 2007.
</p>
</div>
<!-- Google Analytics Code -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-769030-1";
urchinTracker();
</script>
</body>
</html>
